home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / GNU / ispell_src.lha / ispell-3.1.18src / Amiga.readme < prev    next >
Encoding:
Text File  |  1995-09-21  |  7.8 KB  |  197 lines
  1.        International Ispell version 3.1 - Amiga Patch (level 3)
  2.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Introduction
  5. ~~~~~~~~~~~~
  6. This is a Amiga patch of the International Ispell version 3.1.
  7. There is a few differences between this patch and the Ispell 3.3ljr package:
  8.  * 3.3ljr is (AFAIK) based on Ispell version 2, thus not reflecting the
  9.    evolution of international Ispell since 1990.
  10.  * This patch makes only a few changes to the original UN*X code and should
  11.    therefore be compatible with Ispell releases to come (i.e. there is no
  12.    "porting" needed - It will be possible to simply get the newest release and
  13.    compile!).
  14.  * This patch compiles with GCC and needs ixemul.library - there is a much
  15.    bigger overhead compared with 3.3ljr!
  16.  * The EXTENDEDFILECHECK Arexx command has been removed.
  17.  
  18. You should read the "README" file - this file only covers a few Amiga specific
  19. areas.
  20.  
  21.  
  22. Archives
  23. ~~~~~~~~
  24. This Ispell patch will be integrated into the official Ispell source tree
  25. from version 3.1.20 or so. Until then I personally release the source and
  26. binaries in two archives:
  27.  
  28. ispell31p3src.lha - Original ispell-3.1.18 source archive with patch
  29.                     applied. Contains all needed sources for rebuilding
  30.                     ispell binaries and dictionaries.
  31. ispell31p3bin.lha - Contains binaries compiled for Amiga, docs and an
  32.                     English dictionary.
  33.  
  34.  
  35. Installation
  36. ~~~~~~~~~~~~
  37. Dictionaries are to be put in "ispell:lib/" and to ease upgrading you should
  38. put the binaries in "ispell:bin". Add the "ispell:bin" to your path.
  39.  
  40. Private dictionaries will by default be created in "ispell:lib/", named after
  41. the language e.g. '.ispell_english'. You may specify an absolute path/name for
  42. the dictionary with the -p option (remember; no space after the 'p', e.g.
  43. -pMyDictionary).
  44.  
  45. Several people complained about problems with the private dictionary in patch
  46. level 2. These were caused by the ixemul library. The problems should be
  47. solved by setting the HOME environment variable. Apparently this is not
  48. enough for all configurations so Jörgen Grahn made a patch which removes
  49. this dependency of the HOME variable. If you think this is a bad idea (i.e.
  50. if you are using multi-user FS) please let me know!
  51.  
  52.  
  53. Usage & Documentation
  54. ~~~~~~~~~~~~~~~~~~~~~
  55. Consult the man pages for general Ispell usage.
  56. You should know that I have removed the '-vv' option - if you need compile
  57. info check out the source archive.
  58.  
  59. The ARexx interface is more or less the same as the one found in 3.3ljr
  60. ispell. Consult the file "doc/AmigaArexx.doc" for a description of the Arexx
  61. interface.
  62. Since the operation of Ispell has changed from the days of 3.3ljr Ispell the
  63. old Ispell interfaces are not up-to-date. They may need a little patching
  64. themselves to be usable with Ispell 3.1.18. I included them to give you an
  65. idea of how to make an interface Ispell.
  66. If you use FrexxEd there should be an "FrexxEd - Ispell" interface available
  67. from next FrexxEd release.
  68.  
  69. For Amiga users without knowledge of man/groff and the like, I have included
  70. the man pages in "readable" form in Amiga/doc. If your reader can not
  71. understand the style codes, you can remove them with the type command:
  72. "type file > file.raw"
  73.  
  74.  
  75. GCC compilation
  76. ~~~~~~~~~~~~~~~
  77. First remove the suffix ".Amiga" from the Amiga specific versions of local.h
  78. and the Makefile.
  79.  
  80. Then simply "make programs". I was able to compile all the programs in the
  81. Ispell package without errors or warnings. The dictionaries are another story
  82. though; I had to "compile" them by hand without the use of make (run through
  83. the Makefile yourself).
  84.  
  85. All changes made in the original UN*X code are marked by a "#if(n)def AMIGA"
  86. condition.
  87.  
  88.  
  89. Dictionary Generation
  90. ~~~~~~~~~~~~~~~~~~~~~
  91. Get the source archive and find out how by reading the languages/README file.
  92. If you want to generate any of the dictionaries in the source archive you
  93. should do it by hand as the Makefile does not work on Amigas (doesn't on
  94. mine anyway).
  95. Consult the file "doc/BuildDictionary.doc" for two examples of building
  96. Ispell dictionaries.
  97.  
  98. As this may seem a bit tedious for the average user I ask anyone who
  99. successfully generate a dictionary file for a language to upload it to AmiNet
  100. and possibly notify Fred Fish!
  101.  
  102.  
  103. History
  104. ~~~~~~~
  105. 29.06.95 (patch level 1)
  106.  
  107. * All the server commands seem to be fully functional, but they have not been
  108.   tested extensively :(
  109. * There seems to be a memory loss of 440 bytes at each invokation - I think
  110.   it is a problem with ixemul or ispell as it occurs even if the ARexx server
  111.   is not started. I have not checked into it!
  112.  
  113.  
  114. 03.07.95 (patch level 2)
  115.  
  116. * Added server command "ACCEPT".
  117. * The -p and -d options now use "correct" Amiga file name conventions.
  118.  
  119.  
  120. 21.09.95 (patch level 3)
  121.  
  122. * Added documentation on building dictionaries.
  123. * Added a few patches by Jörgen Grahn (I have lost your Email address!)
  124.   - The MASKBITS increased to 128 - you can not use the old hash file, sorry!
  125.   - Removed the HOME environment variable dependency.
  126.  
  127.  
  128. Legal blurb
  129. ~~~~~~~~~~~
  130. International Ispell Version 3.1.18 01/14/95
  131. Copyright (c), 1983, by Pace Willisson
  132. International version Copyright (c) 1987, 1988, 1990, 1991, 1992, 1993,
  133. by Geoff Kuenning, Granada Hills, CA.  All rights reserved.
  134.  
  135. Redistribution and use in source and binary forms, with or without
  136. modification, are permitted provided that the following conditions
  137. are met:
  138.  
  139. 1. Redistributions of source code must retain the above copyright
  140.    notice, this list of conditions and the following disclaimer.
  141. 2. Redistributions in binary form must reproduce the above
  142.    copyright notice, this list of conditions and the following
  143.    disclaimer in the documentation and/or other materials provided
  144.    with the distribution.
  145. 3. All modifications to the source code must be clearly marked as
  146.    such.  Binary redistributions based on modified source code
  147.    must be clearly marked as modified versions in the documentation
  148.    and/or other materials provided with the distribution.
  149. 4. All advertising materials mentioning features or use of this
  150.    software must display the following acknowledgment:
  151.      This product includes software developed by Geoff Kuenning and
  152.      other unpaid contributors.
  153. 5. The name of Geoff Kuenning may not be used to endorse or promote
  154.    products derived from this software without specific prior
  155.    written permission.
  156.  
  157. THIS SOFTWARE IS PROVIDED BY GEOFF KUENNING AND CONTRIBUTORS ``AS
  158. IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  159. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  160. FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GEOFF
  161. KUENNING OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  162. INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  163. (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  164. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  165. HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  166. STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  167. ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  168. OF THE POSSIBILITY OF SUCH DAMAGE.
  169.  
  170. ~
  171.  
  172. Amiga Patch 3 (21.09.95) by Jesper Skov, based on work by Loren J. Rittle.
  173. Additional Amiga changes by Jörgen Grahn.
  174.  
  175. This patch is based on the ARexx interface found in
  176. ISpell Version 3.3LJR, copyright (C) 1990, 1991, 1992 Loren J. Rittle.
  177. The documentation files are also from the ljr archive.
  178.  
  179. The ARexx interface is based on the MinRexx package by Tom Rokicki of Radical
  180. Eye Software.
  181.  
  182. Also included in this archive is the interfaces supplied by various people.
  183. Excerpt from the LJR readme:
  184.  
  185. Thanks to Mike Meyer for the mg interface to ISpell.
  186. Thanks to Willy G. J. Langeveld for enhanced TurboText interface to ISpell.
  187. Thanks to Christopher A. Wichura for the TurboText interface to GUISpell.
  188. Thanks to Steve Koren for the GNU EMACS interface to ISpell.
  189.  
  190.  
  191. / Jesper Skov
  192.   Sallingsundvej 47 st th
  193.   DK-9220 Aalbog Ø
  194.   Denmark
  195.  
  196.   Email: jskov@iesd.auc.dk
  197.